<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Biometric Embedded Platform: api/inc/fpc_bep_sensor.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Biometric Embedded Platform
   &#160;<span id="projectnumber">fpc_bep_kaadas_21.0.1.002</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fpc__bep__sensor_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">fpc_bep_sensor.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="fpc__bep__sensor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2017 Fingerprint Cards AB &lt;tech@fingerprints.com&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * All rights are reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Proprietary and confidential.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Unauthorized copying of this file, via any medium is strictly prohibited.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Any use is subject to an appropriate license granted by Fingerprint Cards AB.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef FPC_BEP_SENSOR_H</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#define FPC_BEP_SENSOR_H</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="fpc__bep__types_8h.html">fpc_bep_types.h</a>&quot;</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &quot;fpc_bep_sensors.h&quot;</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html">   43</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#ac99cecd6ed09b4a779c685a30184b846">   45</a></span>&#160;    <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structfpc__bep__sensor__prop__t.html#ac99cecd6ed09b4a779c685a30184b846">name</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#ae94c13d34ab7f678e6e991ed1a6f3339">   47</a></span>&#160;    <a class="code" href="fpc__bep__types_8h.html#a2c9d883c6aa5a2e7f59227c6ecaaacc6">fpc_bep_sensor_type_t</a> <a class="code" href="structfpc__bep__sensor__prop__t.html#ae94c13d34ab7f678e6e991ed1a6f3339">sensor_type</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#a5741102024b51a8e11dbcf0e8776eb43">   49</a></span>&#160;    uint16_t <a class="code" href="structfpc__bep__sensor__prop__t.html#a5741102024b51a8e11dbcf0e8776eb43">width</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#a0dd19cbe97e48d05756886c57265e979">   51</a></span>&#160;    uint16_t <a class="code" href="structfpc__bep__sensor__prop__t.html#a0dd19cbe97e48d05756886c57265e979">height</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#a85ab2fb3bda9f1c60ef5dbec8cce0390">   53</a></span>&#160;    uint16_t <a class="code" href="structfpc__bep__sensor__prop__t.html#a85ab2fb3bda9f1c60ef5dbec8cce0390">dpi</a>;</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#a338821461c454697d8dca8132589ed9a">   55</a></span>&#160;    uint32_t <a class="code" href="structfpc__bep__sensor__prop__t.html#a338821461c454697d8dca8132589ed9a">max_spi_clock</a>;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#a41d075bafc066cdd86bfca185cc6ce62">   57</a></span>&#160;    uint8_t  <a class="code" href="structfpc__bep__sensor__prop__t.html#a41d075bafc066cdd86bfca185cc6ce62">num_sub_areas_width</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__prop__t.html#a3330302acf537f05f18aa31847962dcf">   59</a></span>&#160;    uint8_t  <a class="code" href="structfpc__bep__sensor__prop__t.html#a3330302acf537f05f18aa31847962dcf">num_sub_areas_height</a>;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;} <a class="code" href="structfpc__bep__sensor__prop__t.html">fpc_bep_sensor_prop_t</a>;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__param__t.html">   65</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__param__t.html#a48c1fdae6a1d0dd1916732dfbadc6661">   67</a></span>&#160;    uint8_t <a class="code" href="structfpc__bep__sensor__param__t.html#a48c1fdae6a1d0dd1916732dfbadc6661">nbr_of_finger_present_zones</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__param__t.html#a2a2cfb834251eb061c4a58738221cf05">   69</a></span>&#160;    <a class="code" href="fpc__bep__types_8h.html#a58f034417a4e1bc9cef9137aa3aa031f">fpc_bep_sensor_driver_mechanism_t</a> <a class="code" href="structfpc__bep__sensor__param__t.html#a2a2cfb834251eb061c4a58738221cf05">driver_mechanism</a>;</div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__param__t.html#a38d631c84c21da901a3dbbd526bcdc64">   71</a></span>&#160;    <a class="code" href="fpc__bep__types_8h.html#ac4da354010b9012ce2767da249de35b9">fpc_bep_sensor_reset_t</a> <a class="code" href="structfpc__bep__sensor__param__t.html#a38d631c84c21da901a3dbbd526bcdc64">reset</a>;</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structfpc__bep__sensor__param__t.html#ac49305025c4fa59a9804c66f78843d85">   73</a></span>&#160;    <a class="code" href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579">fpc_bep_sensor_state_after_release_t</a> <a class="code" href="structfpc__bep__sensor__param__t.html#ac49305025c4fa59a9804c66f78843d85">release_state</a>;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;} <a class="code" href="structfpc__bep__sensor__param__t.html">fpc_bep_sensor_param_t</a>;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<a class="code" href="fpc__bep__types_8h.html#a2c9d883c6aa5a2e7f59227c6ecaaacc6">fpc_bep_sensor_type_t</a> <a class="code" href="fpc__bep__sensor_8h.html#afe89d73d3f6317bc17f96d40cfc2fd5c">fpc_bep_sensor_get_type</a>(<span class="keyword">const</span> <a class="code" href="fpc__bep__types_8h.html#aa5f53a6c77b54a8f592f9c81480e79a5">fpc_bep_sensor_t</a> *sensor);</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#a9f7816865c3cbb3e528b72a10e51f760">fpc_bep_sensor_get_recommended_param</a>(<span class="keyword">const</span> <a class="code" href="fpc__bep__types_8h.html#aa5f53a6c77b54a8f592f9c81480e79a5">fpc_bep_sensor_t</a> *sensor,</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;                                                      <a class="code" href="structfpc__bep__sensor__param__t.html">fpc_bep_sensor_param_t</a> *param);</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#a7d7ca04903a7b5f993ac7a4019f97b3e">fpc_bep_sensor_init</a>(<span class="keyword">const</span> <a class="code" href="fpc__bep__types_8h.html#aa5f53a6c77b54a8f592f9c81480e79a5">fpc_bep_sensor_t</a> *sensor, <span class="keyword">const</span> uint8_t *calibration,</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;        <span class="keyword">const</span> <a class="code" href="structfpc__bep__sensor__param__t.html">fpc_bep_sensor_param_t</a> *param);</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#ad079e331d8f2db958daedb175de7df16">fpc_bep_sensor_release</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#ae3dde0b3a7ee4b46f3edb3a5e57e527a">fpc_bep_sensor_sleep</a>(uint16_t sleep_time);</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;</div><div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="fpc__bep__sensor_8h.html#a23bc3ffb7309cffebf1242d6a77d6798">fpc_bep_finger_detect</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;</div><div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#adc02283e359669904ea35544b81d8782">fpc_bep_sensor_keep_in_idle</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;</div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#a6d9cdb24d60dbdfa50eed9c87ec366f3">fpc_bep_sensor_deep_sleep</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;</div><div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#abff59351f56fca4d0ac5de8e0027bd39">fpc_bep_check_finger_present</a>(<a class="code" href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6b">fpc_bep_finger_status_t</a> *finger_status);</div><div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;</div><div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#a70d88fd94696259b75f110477b79db1b">fpc_bep_get_finger_detect_zones</a>(uint16_t *finger_detect_zones);</div><div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;</div><div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#ab5648089bf85fd31b4adde578783c33d">fpc_bep_capture</a>(<a class="code" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *image);</div><div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;</div><div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#a46d95bd3e7999db7029cee1c7c8d37e1">fpc_bep_sensor_reset</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;</div><div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#a1efdd9b9237ee66570e9adfdb806ccce">fpc_bep_sensor_properties</a>(<a class="code" href="structfpc__bep__sensor__prop__t.html">fpc_bep_sensor_prop_t</a> *properties);</div><div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;</div><div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fpc__bep__sensor_8h.html#a6c6fd4640fe4d05846a9d8f0268ecd7e">fpc_bep_signal_image_capture_start</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;</div><div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__bep__sensor_8h.html#ac802aa6f23460af1a9c0c695a4e01c6a">fpc_bep_sensor_read_otp</a>(uint8_t addr, uint8_t *data, <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;</div><div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FPC_BEP_SENSOR_H */</span><span class="preprocessor"></span></div><div class="ttc" id="fpc__bep__types_8h_html"><div class="ttname"><a href="fpc__bep__types_8h.html">fpc_bep_types.h</a></div><div class="ttdoc">Biometric Embedded Platform types. </div></div>
<div class="ttc" id="fpc__bep__types_8h_html_a1c3740269395cfccd0aef5ac41559a6b"><div class="ttname"><a href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6b">fpc_bep_finger_status_t</a></div><div class="ttdeci">fpc_bep_finger_status_t</div><div class="ttdoc">Finger present status. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:155</div></div>
<div class="ttc" id="structfpc__bep__sensor__param__t_html"><div class="ttname"><a href="structfpc__bep__sensor__param__t.html">fpc_bep_sensor_param_t</a></div><div class="ttdoc">Configurable parameters for FPC BEP sensor functions. </div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:65</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a23bc3ffb7309cffebf1242d6a77d6798"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a23bc3ffb7309cffebf1242d6a77d6798">fpc_bep_finger_detect</a></div><div class="ttdeci">bool fpc_bep_finger_detect(void)</div><div class="ttdoc">Gets the result of the latest reduced finger present query. </div></div>
<div class="ttc" id="fpc__bep__types_8h_html_aa6e74077b38c2f61ddf287bc03c09579"><div class="ttname"><a href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579">fpc_bep_sensor_state_after_release_t</a></div><div class="ttdeci">fpc_bep_sensor_state_after_release_t</div><div class="ttdoc">FPC sensor state after BEP release. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:190</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_ab5648089bf85fd31b4adde578783c33d"><div class="ttname"><a href="fpc__bep__sensor_8h.html#ab5648089bf85fd31b4adde578783c33d">fpc_bep_capture</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_capture(fpc_bep_image_t *image)</div><div class="ttdoc">Captures an image from the sensor. </div></div>
<div class="ttc" id="structfpc__bep__sensor__param__t_html_a2a2cfb834251eb061c4a58738221cf05"><div class="ttname"><a href="structfpc__bep__sensor__param__t.html#a2a2cfb834251eb061c4a58738221cf05">fpc_bep_sensor_param_t::driver_mechanism</a></div><div class="ttdeci">fpc_bep_sensor_driver_mechanism_t driver_mechanism</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:69</div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_a0dd19cbe97e48d05756886c57265e979"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#a0dd19cbe97e48d05756886c57265e979">fpc_bep_sensor_prop_t::height</a></div><div class="ttdeci">uint16_t height</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:51</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a1efdd9b9237ee66570e9adfdb806ccce"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a1efdd9b9237ee66570e9adfdb806ccce">fpc_bep_sensor_properties</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_properties(fpc_bep_sensor_prop_t *properties)</div><div class="ttdoc">Gets the sensor properties. </div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html">fpc_bep_sensor_prop_t</a></div><div class="ttdoc">Properties for fingerprint sensor. </div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:43</div></div>
<div class="ttc" id="structfpc__bep__sensor__param__t_html_ac49305025c4fa59a9804c66f78843d85"><div class="ttname"><a href="structfpc__bep__sensor__param__t.html#ac49305025c4fa59a9804c66f78843d85">fpc_bep_sensor_param_t::release_state</a></div><div class="ttdeci">fpc_bep_sensor_state_after_release_t release_state</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:73</div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_a41d075bafc066cdd86bfca185cc6ce62"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#a41d075bafc066cdd86bfca185cc6ce62">fpc_bep_sensor_prop_t::num_sub_areas_width</a></div><div class="ttdeci">uint8_t num_sub_areas_width</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:57</div></div>
<div class="ttc" id="fpc__bep__types_8h_html_ac4da354010b9012ce2767da249de35b9"><div class="ttname"><a href="fpc__bep__types_8h.html#ac4da354010b9012ce2767da249de35b9">fpc_bep_sensor_reset_t</a></div><div class="ttdeci">fpc_bep_sensor_reset_t</div><div class="ttdoc">FPC sensor reset type. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:179</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_ad079e331d8f2db958daedb175de7df16"><div class="ttname"><a href="fpc__bep__sensor_8h.html#ad079e331d8f2db958daedb175de7df16">fpc_bep_sensor_release</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_release(void)</div><div class="ttdoc">Releases the fingerprint sensor part of FPC BEP library. </div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_ac99cecd6ed09b4a779c685a30184b846"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#ac99cecd6ed09b4a779c685a30184b846">fpc_bep_sensor_prop_t::name</a></div><div class="ttdeci">const char * name</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:45</div></div>
<div class="ttc" id="fpc__bep__types_8h_html_adf46f9c3966202d9cf52a82981adaea4"><div class="ttname"><a href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a></div><div class="ttdeci">fpc_bep_result_t</div><div class="ttdoc">Common results returned by BEP functions. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:77</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_abff59351f56fca4d0ac5de8e0027bd39"><div class="ttname"><a href="fpc__bep__sensor_8h.html#abff59351f56fca4d0ac5de8e0027bd39">fpc_bep_check_finger_present</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_check_finger_present(fpc_bep_finger_status_t *finger_status)</div><div class="ttdoc">Checks if there is a finger present on the sensor. </div></div>
<div class="ttc" id="fpc__bep__types_8h_html_a2c9d883c6aa5a2e7f59227c6ecaaacc6"><div class="ttname"><a href="fpc__bep__types_8h.html#a2c9d883c6aa5a2e7f59227c6ecaaacc6">fpc_bep_sensor_type_t</a></div><div class="ttdeci">fpc_bep_sensor_type_t</div><div class="ttdoc">Fingerprint sensor type enumeration. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:147</div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_a85ab2fb3bda9f1c60ef5dbec8cce0390"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#a85ab2fb3bda9f1c60ef5dbec8cce0390">fpc_bep_sensor_prop_t::dpi</a></div><div class="ttdeci">uint16_t dpi</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:53</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a70d88fd94696259b75f110477b79db1b"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a70d88fd94696259b75f110477b79db1b">fpc_bep_get_finger_detect_zones</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_get_finger_detect_zones(uint16_t *finger_detect_zones)</div><div class="ttdoc">Returns the status of the fngrPresentStatus register. </div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_ae3dde0b3a7ee4b46f3edb3a5e57e527a"><div class="ttname"><a href="fpc__bep__sensor_8h.html#ae3dde0b3a7ee4b46f3edb3a5e57e527a">fpc_bep_sensor_sleep</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_sleep(uint16_t sleep_time)</div><div class="ttdoc">Activates the sensor sleep mode. </div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a6c6fd4640fe4d05846a9d8f0268ecd7e"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a6c6fd4640fe4d05846a9d8f0268ecd7e">fpc_bep_signal_image_capture_start</a></div><div class="ttdeci">void fpc_bep_signal_image_capture_start(void)</div><div class="ttdoc">Signals that actual image capture is started, after finger detect. </div></div>
<div class="ttc" id="structfpc__bep__sensor__param__t_html_a38d631c84c21da901a3dbbd526bcdc64"><div class="ttname"><a href="structfpc__bep__sensor__param__t.html#a38d631c84c21da901a3dbbd526bcdc64">fpc_bep_sensor_param_t::reset</a></div><div class="ttdeci">fpc_bep_sensor_reset_t reset</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:71</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a9f7816865c3cbb3e528b72a10e51f760"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a9f7816865c3cbb3e528b72a10e51f760">fpc_bep_sensor_get_recommended_param</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_get_recommended_param(const fpc_bep_sensor_t *sensor, fpc_bep_sensor_param_t *param)</div><div class="ttdoc">Gets recommended sensor function configuration parameters for the FPC BEP library. </div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_a338821461c454697d8dca8132589ed9a"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#a338821461c454697d8dca8132589ed9a">fpc_bep_sensor_prop_t::max_spi_clock</a></div><div class="ttdeci">uint32_t max_spi_clock</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:55</div></div>
<div class="ttc" id="fpc__bep__types_8h_html_aac8124c8124fff6434f4442baa231459"><div class="ttname"><a href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a></div><div class="ttdeci">struct fpc_bep_image fpc_bep_image_t</div><div class="ttdoc">Image used to store a captured image. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:210</div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_a3330302acf537f05f18aa31847962dcf"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#a3330302acf537f05f18aa31847962dcf">fpc_bep_sensor_prop_t::num_sub_areas_height</a></div><div class="ttdeci">uint8_t num_sub_areas_height</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:59</div></div>
<div class="ttc" id="structfpc__bep__sensor__param__t_html_a48c1fdae6a1d0dd1916732dfbadc6661"><div class="ttname"><a href="structfpc__bep__sensor__param__t.html#a48c1fdae6a1d0dd1916732dfbadc6661">fpc_bep_sensor_param_t::nbr_of_finger_present_zones</a></div><div class="ttdeci">uint8_t nbr_of_finger_present_zones</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:67</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_adc02283e359669904ea35544b81d8782"><div class="ttname"><a href="fpc__bep__sensor_8h.html#adc02283e359669904ea35544b81d8782">fpc_bep_sensor_keep_in_idle</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_keep_in_idle(void)</div><div class="ttdoc">Activates and keeps the sensor in idle mode. </div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_a5741102024b51a8e11dbcf0e8776eb43"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#a5741102024b51a8e11dbcf0e8776eb43">fpc_bep_sensor_prop_t::width</a></div><div class="ttdeci">uint16_t width</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:49</div></div>
<div class="ttc" id="fpc__bep__types_8h_html_a58f034417a4e1bc9cef9137aa3aa031f"><div class="ttname"><a href="fpc__bep__types_8h.html#a58f034417a4e1bc9cef9137aa3aa031f">fpc_bep_sensor_driver_mechanism_t</a></div><div class="ttdeci">fpc_bep_sensor_driver_mechanism_t</div><div class="ttdoc">FPC sensor driver mechanism. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:169</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_ac802aa6f23460af1a9c0c695a4e01c6a"><div class="ttname"><a href="fpc__bep__sensor_8h.html#ac802aa6f23460af1a9c0c695a4e01c6a">fpc_bep_sensor_read_otp</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_read_otp(uint8_t addr, uint8_t *data, size_t size)</div><div class="ttdoc">Read from sensor OTP memory. </div></div>
<div class="ttc" id="structfpc__bep__sensor__prop__t_html_ae94c13d34ab7f678e6e991ed1a6f3339"><div class="ttname"><a href="structfpc__bep__sensor__prop__t.html#ae94c13d34ab7f678e6e991ed1a6f3339">fpc_bep_sensor_prop_t::sensor_type</a></div><div class="ttdeci">fpc_bep_sensor_type_t sensor_type</div><div class="ttdef"><b>Definition:</b> fpc_bep_sensor.h:47</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_afe89d73d3f6317bc17f96d40cfc2fd5c"><div class="ttname"><a href="fpc__bep__sensor_8h.html#afe89d73d3f6317bc17f96d40cfc2fd5c">fpc_bep_sensor_get_type</a></div><div class="ttdeci">fpc_bep_sensor_type_t fpc_bep_sensor_get_type(const fpc_bep_sensor_t *sensor)</div><div class="ttdoc">Gets the sensor type for a specific sensor. </div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a7d7ca04903a7b5f993ac7a4019f97b3e"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a7d7ca04903a7b5f993ac7a4019f97b3e">fpc_bep_sensor_init</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_init(const fpc_bep_sensor_t *sensor, const uint8_t *calibration, const fpc_bep_sensor_param_t *param)</div><div class="ttdoc">Initializes the fingerprint sensor part of FPC BEP library. </div></div>
<div class="ttc" id="fpc__bep__types_8h_html_aa5f53a6c77b54a8f592f9c81480e79a5"><div class="ttname"><a href="fpc__bep__types_8h.html#aa5f53a6c77b54a8f592f9c81480e79a5">fpc_bep_sensor_t</a></div><div class="ttdeci">struct fpc_bep_sensor fpc_bep_sensor_t</div><div class="ttdoc">Sensor. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:215</div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a46d95bd3e7999db7029cee1c7c8d37e1"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a46d95bd3e7999db7029cee1c7c8d37e1">fpc_bep_sensor_reset</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_reset(void)</div><div class="ttdoc">Resets the sensor. </div></div>
<div class="ttc" id="fpc__bep__sensor_8h_html_a6d9cdb24d60dbdfa50eed9c87ec366f3"><div class="ttname"><a href="fpc__bep__sensor_8h.html#a6d9cdb24d60dbdfa50eed9c87ec366f3">fpc_bep_sensor_deep_sleep</a></div><div class="ttdeci">fpc_bep_result_t fpc_bep_sensor_deep_sleep(void)</div><div class="ttdoc">Activates the sensor deep sleep mode. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</a></li><li class="navelem"><a class="el" href="dir_d218fd71c02742082feaad64e43c1ecd.html">inc</a></li><li class="navelem"><a class="el" href="fpc__bep__sensor_8h.html">fpc_bep_sensor.h</a></li>
    <li class="footer">Generated on Tue Nov 9 2021 12:12:59 for Biometric Embedded Platform by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
